org.springframework.jdbc.core

Class PreparedStatementCreatorFactory

java.lang.Object

org.springframework.jdbc.core.PreparedStatementCreatorFactory

public class PreparedStatementCreatorFactory
extends java.lang.Object

Helper class that efficiently creates multiple PreparedStatementCreator objects with different parameters based on a SQL statement and a single set of parameter declarations.

Author:

Rod Johnson, Thomas Risberg, Juergen Hoeller

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	PreparedStatementCreatorFactory.PreparedStatementCreatorImpl PreparedStatementCreator implementation returned by this class.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<SqlParameter>	declaredParameters List of SqlParameter objects.
private java.lang.String[]	generatedKeysColumnNames
private NativeJdbcExtractor	nativeJdbcExtractor
private int	resultSetType
private boolean	returnGeneratedKeys
private java.lang.String	sql The SQL, which won't change when the parameters change
private boolean	updatableResults

Constructor Summary

Constructors

Constructor and Description
PreparedStatementCreatorFactory(java.lang.String sql) Create a new factory.
PreparedStatementCreatorFactory(java.lang.String sql, int[] types) Create a new factory with the given SQL and JDBC types.
PreparedStatementCreatorFactory(java.lang.String sql, java.util.List<SqlParameter> declaredParameters) Create a new factory with the given SQL and parameters.

Method Summary

Methods

Modifier and Type	Method and Description
void	addParameter(SqlParameter param) Add a new declared parameter.
PreparedStatementCreator	newPreparedStatementCreator(java.util.List<?> params) Return a new PreparedStatementCreator for the given parameters.
PreparedStatementCreator	newPreparedStatementCreator(java.lang.Object[] params) Return a new PreparedStatementCreator for the given parameters.
PreparedStatementCreator	newPreparedStatementCreator(java.lang.String sqlToUse, java.lang.Object[] params) Return a new PreparedStatementCreator for the given parameters.
PreparedStatementSetter	newPreparedStatementSetter(java.util.List<?> params) Return a new PreparedStatementSetter for the given parameters.
PreparedStatementSetter	newPreparedStatementSetter(java.lang.Object[] params) Return a new PreparedStatementSetter for the given parameters.
void	setGeneratedKeysColumnNames(java.lang.String[] names) Set the column names of the auto-generated keys.
void	setNativeJdbcExtractor(NativeJdbcExtractor nativeJdbcExtractor) Specify the NativeJdbcExtractor to use for unwrapping PreparedStatements, if any.
void	setResultSetType(int resultSetType) Set whether to use prepared statements that return a specific type of ResultSet.
void	setReturnGeneratedKeys(boolean returnGeneratedKeys) Set whether prepared statements should be capable of returning auto-generated keys.
void	setUpdatableResults(boolean updatableResults) Set whether to use prepared statements capable of returning updatable ResultSets.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sql

private final java.lang.String sql

The SQL, which won't change when the parameters change

declaredParameters

private final java.util.List<SqlParameter> declaredParameters

List of SqlParameter objects. May not be null.

resultSetType

private int resultSetType

updatableResults

private boolean updatableResults

returnGeneratedKeys

private boolean returnGeneratedKeys

generatedKeysColumnNames

private java.lang.String[] generatedKeysColumnNames

nativeJdbcExtractor

private NativeJdbcExtractor nativeJdbcExtractor

Constructor Detail

PreparedStatementCreatorFactory

public PreparedStatementCreatorFactory(java.lang.String sql)

Create a new factory. Will need to add parameters via the addParameter(org.springframework.jdbc.core.SqlParameter) method or have no parameters.

PreparedStatementCreatorFactory

public PreparedStatementCreatorFactory(java.lang.String sql,
                               int[] types)

Create a new factory with the given SQL and JDBC types.

Parameters:

sql - SQL to execute

types - int array of JDBC types

PreparedStatementCreatorFactory

public PreparedStatementCreatorFactory(java.lang.String sql,
                               java.util.List<SqlParameter> declaredParameters)

Create a new factory with the given SQL and parameters.

Parameters:

sql - SQL

declaredParameters - list of SqlParameter objects

See Also:

SqlParameter

Method Detail

addParameter

public void addParameter(SqlParameter param)

Add a new declared parameter.

Order of parameter addition is significant.

Parameters:

param - the parameter to add to the list of declared parameters

setResultSetType

public void setResultSetType(int resultSetType)

Set whether to use prepared statements that return a specific type of ResultSet.

Parameters:

resultSetType - the ResultSet type

See Also:

ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, ResultSet.TYPE_SCROLL_SENSITIVE

setUpdatableResults

public void setUpdatableResults(boolean updatableResults)

Set whether to use prepared statements capable of returning updatable ResultSets.

setReturnGeneratedKeys

public void setReturnGeneratedKeys(boolean returnGeneratedKeys)

Set whether prepared statements should be capable of returning auto-generated keys.

setGeneratedKeysColumnNames

public void setGeneratedKeysColumnNames(java.lang.String[] names)

Set the column names of the auto-generated keys.

setNativeJdbcExtractor

public void setNativeJdbcExtractor(NativeJdbcExtractor nativeJdbcExtractor)

Specify the NativeJdbcExtractor to use for unwrapping PreparedStatements, if any.

newPreparedStatementSetter

public PreparedStatementSetter newPreparedStatementSetter(java.util.List<?> params)

Return a new PreparedStatementSetter for the given parameters.

Parameters:

params - list of parameters (may be null)

newPreparedStatementSetter

public PreparedStatementSetter newPreparedStatementSetter(java.lang.Object[] params)

Return a new PreparedStatementSetter for the given parameters.

Parameters:

params - the parameter array (may be null)

newPreparedStatementCreator

public PreparedStatementCreator newPreparedStatementCreator(java.util.List<?> params)

Return a new PreparedStatementCreator for the given parameters.

Parameters:

params - list of parameters (may be null)

newPreparedStatementCreator

public PreparedStatementCreator newPreparedStatementCreator(java.lang.Object[] params)

Return a new PreparedStatementCreator for the given parameters.

Parameters:

params - the parameter array (may be null)

newPreparedStatementCreator

public PreparedStatementCreator newPreparedStatementCreator(java.lang.String sqlToUse,
                                                   java.lang.Object[] params)

Return a new PreparedStatementCreator for the given parameters.

Parameters:

sqlToUse - the actual SQL statement to use (if different from the factory's, for example because of named parameter expanding)

params - the parameter array (may be null)